<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>WebCL: IWebCL Interface Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">WebCL
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">IWebCL Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="IWebCL" -->
<p>Main WebCL component interface.  
 <a href="interfaceIWebCL.html#details">More...</a></p>

<p><code>import &quot;<a class="el" href="IWebCL_8idl_source.html">IWebCL.idl</a>&quot;;</code></p>

<p><a href="interfaceIWebCL-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">nsIVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCL.html#abe82a152c351c59cd6afc40abcb66c08">getPlatformIDs</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the list of available platforms.  <a href="#abe82a152c351c59cd6afc40abcb66c08"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">nsIVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCL.html#a058d8e8eb483246b5a12fea418f40df3">getPlatforms</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceIWebCLContext.html">IWebCLContext</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCL.html#a514ff0ff130e29b8ad68090fd6f134c4">createContext</a> (in nsIVariant aProperties, in nsIVariant aDevices)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new WebCL context based on a list of devices.  <a href="#a514ff0ff130e29b8ad68090fd6f134c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceIWebCLContext.html">IWebCLContext</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCL.html#ab42840b6e0431c0d0c69ace979bbaf56">createContextFromType</a> (in nsIVariant aProperties, in <a class="el" href="WebCL__types_8idl.html#a2560dcbf9bf24990dcfd566a25920497">T_WebCLDeviceType</a> aDeviceType)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new WebCL context.  <a href="#ab42840b6e0431c0d0c69ace979bbaf56"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCL.html#a309e0cc237e2e0daea9bc82997b1b525">waitForEvents</a> (in nsIVariant aEventList)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for the commands identified by the listed events to complete.  <a href="#a309e0cc237e2e0daea9bc82997b1b525"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCL.html#a08393a53d697845561687c4e50438bf3">unloadCompiler</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Release the resources allocated by the OpenCL compiler.  <a href="#a08393a53d697845561687c4e50438bf3"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute nsIVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCL.html#a41ae5fa7415f72000db9d4b2a19b57fc">types</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Supported data types for kernel arguments.  <a href="#a41ae5fa7415f72000db9d4b2a19b57fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute nsIVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCL.html#a202846ba89bc8e279aa4abcc854aba79">version</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The WebCL version information.  <a href="#a202846ba89bc8e279aa4abcc854aba79"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Main WebCL component interface. </p>
<p>This interface provides the primary access to WebCL functionality, providing an API for retrieving a list of available platforms, context creation and various utilities and constants. This interface is intended to be made directly available for the JavaScript context as a global object or via a constructor. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a514ff0ff130e29b8ad68090fd6f134c4"></a><!-- doxytag: member="IWebCL::createContext" ref="a514ff0ff130e29b8ad68090fd6f134c4" args="(in nsIVariant aProperties, in nsIVariant aDevices)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="interfaceIWebCLContext.html">IWebCLContext</a> <a class="el" href="interfaceIWebCL.html#a514ff0ff130e29b8ad68090fd6f134c4">IWebCL::createContext</a> </td>
          <td>(</td>
          <td class="paramtype">in nsIVariant&#160;</td>
          <td class="paramname"><em>aProperties</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in nsIVariant&#160;</td>
          <td class="paramname"><em>aDevices</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a new WebCL context based on a list of devices. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aProperties</td><td>Array of properties. Names are integers, values can be integers or objects. </td></tr>
    <tr><td class="paramname">aDevices</td><td>Array of devices. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new WebCLContext instance. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clCreateContext </dd></dl>

</div>
</div>
<a class="anchor" id="ab42840b6e0431c0d0c69ace979bbaf56"></a><!-- doxytag: member="IWebCL::createContextFromType" ref="ab42840b6e0431c0d0c69ace979bbaf56" args="(in nsIVariant aProperties, in T_WebCLDeviceType aDeviceType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="interfaceIWebCLContext.html">IWebCLContext</a> <a class="el" href="interfaceIWebCL.html#ab42840b6e0431c0d0c69ace979bbaf56">IWebCL::createContextFromType</a> </td>
          <td>(</td>
          <td class="paramtype">in nsIVariant&#160;</td>
          <td class="paramname"><em>aProperties</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in <a class="el" href="WebCL__types_8idl.html#a2560dcbf9bf24990dcfd566a25920497">T_WebCLDeviceType</a>&#160;</td>
          <td class="paramname"><em>aDeviceType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a new WebCL context. </p>
<p>This function takes the type of devices to use. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aProperties</td><td>Array of properties. Names are integers, values can be integers or objects. </td></tr>
    <tr><td class="paramname">aDeviceType</td><td>The type of devices to use. All suitable devices available on the platform will be used. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new WebCLContext instance. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clCreateContextFromType </dd></dl>

</div>
</div>
<a class="anchor" id="abe82a152c351c59cd6afc40abcb66c08"></a><!-- doxytag: member="IWebCL::getPlatformIDs" ref="abe82a152c351c59cd6afc40abcb66c08" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nsIVariant <a class="el" href="interfaceIWebCL.html#abe82a152c351c59cd6afc40abcb66c08">IWebCL::getPlatformIDs</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the list of available platforms. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array of <a class="el" href="interfaceIWebCLPlatform.html" title="IWebCLPlatform interface abstracts a WebCL platform.">IWebCLPlatform</a> instances as a JSArray wrapped in an nsIVariant. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clGetPlatformIDs </dd></dl>

</div>
</div>
<a class="anchor" id="a058d8e8eb483246b5a12fea418f40df3"></a><!-- doxytag: member="IWebCL::getPlatforms" ref="a058d8e8eb483246b5a12fea418f40df3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nsIVariant <a class="el" href="interfaceIWebCL.html#a058d8e8eb483246b5a12fea418f40df3">IWebCL::getPlatforms</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceIWebCL.html#abe82a152c351c59cd6afc40abcb66c08" title="Get the list of available platforms.">getPlatformIDs</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a08393a53d697845561687c4e50438bf3"></a><!-- doxytag: member="IWebCL::unloadCompiler" ref="a08393a53d697845561687c4e50438bf3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="interfaceIWebCL.html#a08393a53d697845561687c4e50438bf3">IWebCL::unloadCompiler</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Release the resources allocated by the OpenCL compiler. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>clUnloadCompiler </dd></dl>

</div>
</div>
<a class="anchor" id="a309e0cc237e2e0daea9bc82997b1b525"></a><!-- doxytag: member="IWebCL::waitForEvents" ref="a309e0cc237e2e0daea9bc82997b1b525" args="(in nsIVariant aEventList)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="interfaceIWebCL.html#a309e0cc237e2e0daea9bc82997b1b525">IWebCL::waitForEvents</a> </td>
          <td>(</td>
          <td class="paramtype">in nsIVariant&#160;</td>
          <td class="paramname"><em>aEventList</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Wait for the commands identified by the listed events to complete. </p>
<p>The function will block the host thread untill finished. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aEventList</td><td>Array of IWebCLEvents. </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clWaitForEvents </dd></dl>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a41ae5fa7415f72000db9d4b2a19b57fc"></a><!-- doxytag: member="IWebCL::types" ref="a41ae5fa7415f72000db9d4b2a19b57fc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">readonly attribute nsIVariant <a class="el" href="interfaceIWebCL.html#a41ae5fa7415f72000db9d4b2a19b57fc">IWebCL::types</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Supported data types for kernel arguments. </p>
<p>This attribute lists the data type identifiers that are supported for explicit kernel argument type conversions. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>WebCL_types </dd></dl>

</div>
</div>
<a class="anchor" id="a202846ba89bc8e279aa4abcc854aba79"></a><!-- doxytag: member="IWebCL::version" ref="a202846ba89bc8e279aa4abcc854aba79" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">readonly attribute nsIVariant <a class="el" href="interfaceIWebCL.html#a202846ba89bc8e279aa4abcc854aba79">IWebCL::version</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The WebCL version information. </p>
<p>This attribute contains the WebCL version as an array of 4 integers. Index 0 is major API version, 1 is minor API version, 2 is release number and 4 is the source repository revision number of 0 if the value was not available at build time. </p>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>public/<a class="el" href="IWebCL_8idl_source.html">IWebCL.idl</a></li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 7 2012 12:59:51 for WebCL by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
